[Fix] Fixed syncing of effective fields in plugin framework implementation of share resource by tanmay-db · Pull Request #4969 · databricks/terraform-provider-databricks

tanmay-db · 2025-08-22T14:14:48Z

Changes

Planned objects can be less than the state objects. This can happen when someone removes an object in share resource outside the terraform (for example through UI). The changes fixes the syncing of effective fields by making sure we iterate over the planned and state objects properly.

Ref: #4913

Tests

Integration tests

Test panics over main (before these changes): [TEST] [DO NOT MERGE] E2E Test for panic in share resource (pluginfw) #5084
Test passes on the changes in this PR.

Unit tests

Tests panics before the changes (ref):

- Tests passes over the changes

hectorcast-db · 2025-08-27T06:50:26Z

+		for j := range planObjects {
+			if stateObjects[i].Name == planObjects[j].Name {
+				mode.objectLevel(ctx, &stateObjects[i], planObjects[j])
+				finalObjects = append(finalObjects, stateObjects[i])


what happens if the plan as an object which is not in the state? It seems that we are ignoring it.

Yes, we ignore it because in terraform we want to create the infra from the config

Can you explain a bit more what is what? I think I am mixing what stateObjects, planObjects and finalObjects are.
As it is, it feels that we are storing (state) a different set of objects that we are creating (plan).

hectorcast-db · 2025-08-27T12:13:12Z

@@ -446,8 +446,13 @@ func (r *ShareResource) syncEffectiveFields(ctx context.Context, plan, state Sha
 	stateObjects, _ := state.GetObjects(ctx)


Are we suppressing the error? Can this fail?

if d.HasError() { panic(pluginfwcommon.DiagToString(d)) }

The error isn't suppressed: https://github.com/databricks/terraform-provider-databricks/blob/main/internal/service/sharing_tf/legacy_model.go#L4440.

This was added in: https://github.com/databricks/terraform-provider-databricks/pull/4332/files#diff-5f47d9d2d5e2fcf6b377c528600d81c37f4526da6ce6aba43818bdb0f7039152R2365-R2375

…ricks into panic-share-pluginfw

github-actions · 2025-10-11T16:11:43Z

If integration tests don't run automatically, an authorized user can run them manually by following the instructions below:

Trigger:
go/deco-tests-run/terraform

Inputs:

PR number: 4969
Commit SHA: b9c0fc0360ccd420007f307e42163127fb075c7a

Checks will be approved automatically on success.

mgyucht

LGTM!

mgyucht · 2025-10-14T09:54:09Z

+// syncEffectiveFields syncs the effective fields between existingState and newState
+// and returns the newState
+//
+// existingState: infrastructure values that are recorded in the existing terraform state.


This corresponds to the state in Read method and plan in the Create/Update methods.

## Release v1.92.0 ### Breaking Changes * Remove stale resources/datasources/documentation related to Clean Room services. * databricks\_permissions resource no longer updates permissions on delete. This is to mitigate an issue with incorrect IS\_OWNER being set ([#5096](#5096)) ### New Features and Improvements * Add `arm` option to `databricks_node_type` instead of `graviton` ([#5028](#5028)) * Add `data_quality_monitor` resource and data sources ([#5092](#5092)). * Add `data_quality_refresh` resource and data sources ([#5092](#5092)). * Perform workspace-level permission assignment by `user_name`, `group_name`, or `service_principal_name` ([#5068](#5068)). ### Bug Fixes * Fixed syncing of effective fields in plugin framework implementation of share resource ([#4969](#4969)) * Mark `storage_location` as read-only in `databricks_catalog` ([#5075](#5075)) ### Documentation * Add instructions for migration from deprecated `databricks_catalog_workspace_binding` to `databricks_workspace_binding` ([#5054](#5054)) * Document output attributes in `databricks_storage_credential` ([#5093](#5093)) ### Internal Changes * Bump the Go SDK to v0.86.0 ([#5092](#5092)).

…efault (#5089) ## Changes  Make the plugin framework implementation of share resource as default. With this change, `databricks_share` will use the plugin framework implementation. To be merged after: #4969 Note: Removal of SDKv2 implementation will be done in next release so users can fallback to SDKv2 implementation in case there are some issues. ## Tests  Integration tests - Applying: SDKv2 -> Plugin Framework - Applying: Plugin Framework -> SDKv2

[Fix] Fix syncing effective fields in share resource

915f8d7

tanmay-db requested review from a team as code owners August 22, 2025 14:14

tanmay-db requested review from renaudhartert-db and removed request for a team August 22, 2025 14:14

tanmay-db temporarily deployed to test-trigger-is August 22, 2025 14:14 — with GitHub Actions Inactive

tanmay-db removed request for a team and renaudhartert-db August 22, 2025 14:15

tanmay-db mentioned this pull request Aug 22, 2025

[Internal] Make plugin framework implementation of share resource as default #4967

Closed

tanmay-db temporarily deployed to test-trigger-is August 22, 2025 14:15 — with GitHub Actions Inactive

tanmay-db changed the title ~~[Fix] Fix syncing effective fields in share resource~~ [Fix] Fixed syncing of effective fields in plugin framework implementation of share resource Aug 22, 2025

-

f536d67

tanmay-db temporarily deployed to test-trigger-is August 22, 2025 14:18 — with GitHub Actions Inactive

tanmay-db temporarily deployed to test-trigger-is August 22, 2025 14:19 — with GitHub Actions Inactive

-

006c174

tanmay-db temporarily deployed to test-trigger-is August 25, 2025 10:49 — with GitHub Actions Inactive

tanmay-db temporarily deployed to test-trigger-is August 25, 2025 10:50 — with GitHub Actions Inactive

tanmay-db requested review from hectorcast-db, mgyucht, rauchy and renaudhartert-db August 25, 2025 11:02

hectorcast-db reviewed Aug 27, 2025

View reviewed changes

tanmay-db requested a review from hectorcast-db August 27, 2025 09:25

hectorcast-db reviewed Aug 27, 2025

View reviewed changes

rauchy force-pushed the panic-share-pluginfw branch from 006c174 to 881c81c Compare August 28, 2025 11:02

rauchy temporarily deployed to test-trigger-is August 28, 2025 11:02 — with GitHub Actions Inactive

rauchy temporarily deployed to test-trigger-is August 28, 2025 11:03 — with GitHub Actions Inactive

tanmay-db added 2 commits September 11, 2025 14:47

Merge branch 'main' of github.com:databricks/terraform-provider-datab…

34182f2

…ricks into panic-share-pluginfw

-

55e1a33

tanmay-db force-pushed the panic-share-pluginfw branch from 881c81c to 55e1a33 Compare September 11, 2025 13:33

tanmay-db temporarily deployed to test-trigger-is October 8, 2025 11:56 — with GitHub Actions Inactive

tanmay-db temporarily deployed to test-trigger-is October 8, 2025 11:57 — with GitHub Actions Inactive

tanmay-db added 2 commits October 8, 2025 17:00

-

1d0a731

Merge branch 'main' of github.com:databricks/terraform-provider-datab…

c680882

…ricks into panic-share-pluginfw

tanmay-db temporarily deployed to test-trigger-is October 8, 2025 15:00 — with GitHub Actions Inactive

tanmay-db temporarily deployed to test-trigger-is October 8, 2025 15:01 — with GitHub Actions Inactive

-

841a4e1

tanmay-db temporarily deployed to test-trigger-is October 8, 2025 15:03 — with GitHub Actions Inactive

-

c38787f

tanmay-db temporarily deployed to test-trigger-is October 8, 2025 15:45 — with GitHub Actions Inactive

tanmay-db temporarily deployed to test-trigger-is October 8, 2025 15:47 — with GitHub Actions Inactive

-

0485403

tanmay-db temporarily deployed to test-trigger-is October 8, 2025 15:54 — with GitHub Actions Inactive

tanmay-db temporarily deployed to test-trigger-is October 8, 2025 15:55 — with GitHub Actions Inactive

tanmay-db mentioned this pull request Oct 10, 2025

[Internal] Use plugin framework implementation of share resource as default #5089

Merged

merge conflicts

b9c0fc0

tanmay-db temporarily deployed to test-trigger-is October 11, 2025 16:11 — with GitHub Actions Inactive

tanmay-db temporarily deployed to test-trigger-is October 11, 2025 16:12 — with GitHub Actions Inactive

mgyucht approved these changes Oct 14, 2025

View reviewed changes

tanmay-db added this pull request to the merge queue Oct 14, 2025

Merged via the queue into main with commit 0c0272a Oct 14, 2025
12 checks passed

tanmay-db deleted the panic-share-pluginfw branch October 14, 2025 10:21

jeferson-fanduel mentioned this pull request Jul 24, 2026

[ISSUE] Issue with databricks_share resource #5902

Open

Navigation Menu

[Fix] Fixed syncing of effective fields in plugin framework implementation of share resource - #4969

[Fix] Fixed syncing of effective fields in plugin framework implementation of share resource#4969
tanmay-db merged 15 commits into
mainfrom
panic-share-pluginfw

tanmay-db commented Aug 22, 2025 •

edited

Loading

Uh oh!

hectorcast-db Aug 27, 2025

Uh oh!

tanmay-db Aug 27, 2025

Uh oh!

hectorcast-db Aug 27, 2025

Uh oh!

hectorcast-db Aug 27, 2025

Uh oh!

tanmay-db Sep 11, 2025

Uh oh!

github-actions Bot commented Oct 11, 2025

Uh oh!

mgyucht left a comment

Uh oh!

mgyucht Oct 14, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This branch was previously deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		@@ -446,8 +446,13 @@ func (r *ShareResource) syncEffectiveFields(ctx context.Context, plan, state Sha
		stateObjects, _ := state.GetObjects(ctx)

Conversation

tanmay-db commented Aug 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Tests

Uh oh!

hectorcast-db Aug 27, 2025

Choose a reason for hiding this comment

Uh oh!

tanmay-db Aug 27, 2025

Choose a reason for hiding this comment

Uh oh!

hectorcast-db Aug 27, 2025

Choose a reason for hiding this comment

Uh oh!

hectorcast-db Aug 27, 2025

Choose a reason for hiding this comment

Uh oh!

tanmay-db Sep 11, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Oct 11, 2025

Uh oh!

mgyucht left a comment

Choose a reason for hiding this comment

Uh oh!

mgyucht Oct 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This branch was previously deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

tanmay-db commented Aug 22, 2025 •

edited

Loading